Laravel 结合 GatewayWorker 推送消息

一、简述

GatewayWorker基于Workerman开发的一个项目框架，用于快速开发TCP长连接应用，例如app推送服务端、即时IM服务端、游戏服务端、物联网、智能家居等等

GatewayWorker使用经典的Gateway和Worker进程模型。Gateway进程负责维持客户端连接，并转发客户端的数据给BusinessWorker进程处理，BusinessWorker进程负责处理实际的业务逻辑（默认调用Events.php处理业务），并将结果推送给对应的客户端。Gateway服务和BusinessWorker服务可以分开部署在不同的服务器上，实现分布式集群。

GatewayWorker提供非常方便的API，可以全局广播数据、可以向某个群体广播数据、也可以向某个特定客户端推送数据。配合Workerman的定时器，也可以定时推送数据。

二、安装

GatewayWorker 安装在LInux服务器上：

下载地址：GatewayWorker

1、下载 demo

2、命令行运行 unzip GatewayWorker.zip 解压缩GatewayWorker.zip

3、命令行运行 cd GatewayWorker 进入GatewayWorker目录

4、命令行运行 php start.php start 启动 GatewayWorker

5、新开几个命令行窗口运行 telnet 127.0.0.1 8282，输入任意字符即可聊天（非本机测试请将127.0.0.1替换成实际ip）。

注意：如果telnet超时请检查服务器防火墙(iptables)

这里启动的是GatewayWorker的默认端口，要是需要更改要改以下三个文件：
GatewayWorker/Applications/YourApp/start_register.php

// register 必须是text协议；这个端口要保持一致，根据项目自定义
$register = new Register('text://0.0.0.0:1238');

GatewayWorker/Applications/YourApp/start_businessworker.php

// bussinessWorker 进程
$worker = new BusinessWorker();
// worker名称,根据不同的项目自定义
$worker->name = 'YourAppBusinessWorker';
// bussinessWorker进程数量
$worker->count = 4;
// 服务注册地址; 注意这个端口要保持一致，不同的项目可以自定义
$worker->registerAddress = '127.0.0.1:1238';

GatewayWorker/Applications/YourApp/start_gateway.php

// gateway 进程，这里使用Text协议，可以用telnet测试
$gateway = new Gateway("tcp://0.0.0.0:8282");
// gateway名称，status方便查看
$gateway->name = 'YourAppGateway';
// gateway进程数
$gateway->count = 4;
// 本机ip，分布式部署时使用内网ip
$gateway->lanIp = '127.0.0.1';
// 内部通讯起始端口，假如$gateway->count=4，起始端口为4000
// 则一般会使用4000 4001 4002 4003 4个端口作为内部通讯端口 ，不同项目开启不同端口
$gateway->startPort = 2900;
// 服务注册地址；端口保持一致，项目自定义
$gateway->registerAddress = '127.0.0.1:1238';

// 服务端向客户端发送心跳数据的时间间隔 单位：秒。如果设置为0代表不发送心跳检测
//$gateway->pingInterval = 10;
//客户端连续$pingNotResponseLimit次$pingInterval时间内不回应心跳则断开链接。
//如果设置为0代表客户端不用发送回应数据，即通过TCP层面检测连接的连通性（极端情况至少10分钟才能检测到）
//$gateway->pingNotResponseLimit = 2;
// 要发送的心跳请求数据，心跳数据是任意的，只要客户端能识别即可
//$gateway->pingData = '{"type":"ping"}';

注意：需要客户端与服务端保持连接不被断开,可以开启心跳检查定时发送心跳数据。

服务管理

在GatewayWorker根目录下有一个start.php文件：

php start.php  start   启动服务 （php start.php  start  -d   以daemon启动）

php start.php  stop    停止服务

php start.php restart  重新启动 （-d 以daemon启动）

php start.php reload   平滑重启

php start.php  status  服务状态

vagrant@homestead:~/code/GatewayWorker$ php start.php status

Workerman[start.php] status 
----------------------------------------------GLOBAL STATUS----------------------------------------------------
Workerman version:3.5.10          PHP version:7.2.3-1+ubuntu16.04.1+deb.sury.org+1
start time:2018-06-08 14:00:54   run 0 days 2 hours   
load average: 0, 0, 0            event-loop:\Workerman\Events\Select
3 workers       9 processes
worker_name       exit_status      exit_count
YourAppBusinessWorker 0                0
YourAppGateway        0                0
Register          0                0
----------------------------------------------PROCESS STATUS---------------------------------------------------
pid    memory  listening             worker_name       connections send_fail timers  total_request qps    status
4693    2M      none                YourAppBusinessWorker 5           0         0       3             0      [idle]
4694    2M      none                YourAppBusinessWorker 5           0         0       3             0      [idle]
4695    2M      none                YourAppBusinessWorker 5           0         0       156           0      [idle]
4696    2M      none                YourAppBusinessWorker 5           0         0       3             0      [idle]
4697    2M      tcp://0.0.0.0:8282  YourAppGateway        8           0         0       226           0      [idle]
4698    2M      tcp://0.0.0.0:8282  YourAppGateway        8           0         0       226           0      [idle]
4699    2M      tcp://0.0.0.0:8282  YourAppGateway        8           0         0       226           0      [idle]
4700    2M      tcp://0.0.0.0:8282  YourAppGateway        8           0         0       378           0      [idle]
4701    2M      text://0.0.0.0:1238     Register          8           0         0       51            0      [idle]
----------------------------------------------PROCESS STATUS---------------------------------------------------
Summary    18M     -                   -                 60          0         0       1272          0      [Summary]

注意：修改代码要重启服务。

GatewayClient安装下项目中

原则：
现有mvc框架项目与GatewayWorker独立部署互不干扰

所有的业务逻辑都由网站页面post/get到mvc框架中完成

GatewayWorker不接受客户端发来的数据，即GatewayWorker不处理任何业务逻辑，GatewayWorker仅仅当做一个单向的推送通道

仅当mvc框架需要向浏览器主动推送数据时才在mvc框架中调用Gateway的API(GatewayClient)完成推送

当然，这只是官方推荐的结合方式，也不是绝对的。开发者可以自由变化选择结合方式以适应自己的业务需求。 当然也可以采用客户端与GatewayWorker直接双向通讯的方式完成业务通讯。更多参考官方手册。

下载地址：GatewayClient。项目中执行以下命令即可：

composer require workerman/gatewayclient

三、应用

在laravel中结合redis 消息队列（可参考laravel/lumen 使用 redis队列）来完成消息推送。

在controller中使用dispatch触发队列

     dispatch(new YourJob($data));

在Jobs中示例：

<?php

namespace App\Jobs;


use GatewayClient\Gateway;

class YourJob extends Job
{
    /**
     * Create a new job instance.
     *
     * @return void
     */
    protected $id;


    public function __construct($id) 
    {
        $this->id = $id;
    }

    public function handle()
    {
        //业务逻辑
        Gateway::sendToAll(json_encode(['id' => xxx, 'name' => xxx]));
    }
}

每次改动代码重启队列。supervisorctl reload

四、调试

服务器端打开Telnet，不可执行Telnet命令需要安装。
如：

vagrant@homestead:~/code/GatewayWorker$ telnet 127.0.0.1 8282
Trying 127.0.0.1...
Connected to 127.0.0.1.
Escape character is '^]'.
Hello 7f0000010b5600000001
7f0000010b5600000001 login
hello
7f0000010b5600000001 said hello

{"id":"35","name":"xxx"}

正常情况，会输出你想发送的消息。
Escape character is '^]'.是 Ctrl + ] 调出Telnet，输入quit可以退出。

五、配置wss

Workerman如何创建一个wss服务，使得客户端可以用过wss协来连接通讯，比如在微信小程序中连接服务端。

wss协议实际是websocket+SSL，就是在websocket协议上加入SSL层，类似https(http+SSL)。 所以只需要在websocket协议的基础上开启SSL即可支持wss协议。

• 配置方式一：直接用Workerman开启SSL：

准备工作：

1、Workerman版本不小于3.3.7

2、PHP安装了openssl扩展

3、已经申请了证书（pem/crt文件及key文件）放在磁盘任意目录

start_gateway.php中设置以下代码

<?php
require_once __DIR__ . '/Workerman/Autoloader.php';
use Workerman\Worker;

// 证书最好是申请的证书
$context = array(
    // 更多ssl选项请参考手册 http://php.net/manual/zh/context.ssl.php
    'ssl' => array(
        // 请使用绝对路径
        'local_cert'                 => '磁盘路径/server.pem', // 也可以是crt文件
        'local_pk'                   => '磁盘路径/server.key',
        'verify_peer'                => false,
        // 'allow_self_signed' => true, //如果是自签名证书需要开启此选项
    )
);
// 这里设置的是websocket协议（端口任意，但是需要保证没被其它程序占用）
$worker = new Worker('websocket://0.0.0.0:443', $context);
$worker->name = xxx //配置名称便于监控
// 设置transport开启ssl，websocket+ssl即wss
$worker->transport = 'ssl';
$worker->onMessage = function($con, $msg) {
    $con->send('ok');
};

Worker::runAll();

通过以上的代码，Workerman就监听了wss协议，客户端就可以通过wss协议来连接workerman实现安全即时通讯了。

测试
打开chrome浏览器，按F12打开调试控制台，在Console一栏输入(或者把下面代码放入到html页面用js运行)

// 证书是会检查域名的，请使用域名连接

ws = new WebSocket("wss://域名");
ws.onopen = function() {
    alert("连接成功");
    ws.send('tom');
    alert("给服务端发送一个字符串：tom");
};
ws.onmessage = function(e) {
    alert("收到服务端的消息：" + e.data);
};

注意：

1、如果无法启动，则一般是443端口被占用，请改成其它端口，注意改成其它端口后客户端连接时需要带上端口号，客户端连接时地址类似wss://domain.com:xxx ，xxx为端口号。如果必须使用443端口请使用方法二代理的方式实现wss。

2、wss端口只能通过wss协议访问，ws无法访问wss端口。

3、证书一般是与域名绑定的，所以测试的时候客户端请使用域名连接，不要使用ip去连。

4、如果出现无法访问的情况，请检查服务器防火墙。

5、此方法要求PHP版本>=5.6，因为微信小程序要求tls1.2，而PHP5.6以下版本不支持tls1.2。

6、微信小程序要求连接wss时不带端口号，也就是wss端口只能是443。但是443端口一般被nginx/apache占用，此时可以考虑方法二。

• 配置方式二：利用nginx/apache代理wss

利用nginx/apache作为wss代理转发给workerman（注意此方法workerman部分千万不要设置ssl，否则将无法连接）。

通讯原理及流程是：

1、客户端发起wss连接连到nginx/apache

2、nginx/apache将wss协议的数据转换成ws协议数据并转发到Workerman的websocket协议端口

3、Workerman收到数据后做业务逻辑处理

4、Workerman给客户端发送消息时，则是相反的过程，数据经过nginx/apache转换成wss协议然后发给客户端

nginx配置参考

前提条件及准备工作：

1、假设Workerman监听的是8282端口(websocket协议,不要用tcp)
2、已经申请了证书（pem/crt文件及key文件）放在了/etc/nginx/conf.d/ssl下
3、打算利用nginx开启443端口对外提供wss代理服务（端口可以根据需要修改）
4、nginx一般作为网站服务器运行着其它服务，为了不影响原来的站点使用，这里使用地址 域名/wss 作为wss的代理入口。也就是客户端连接地址为 wss://域名/wss

nginx配置类似如下：

server {
  listen 443;

  ssl on;
  ssl_certificate /etc/ssl/server.pem;
  ssl_certificate_key /etc/ssl/server.key;
  ssl_session_timeout 5m;
  ssl_session_cache shared:SSL:50m;
  ssl_protocols SSLv3 SSLv2 TLSv1 TLSv1.1 TLSv1.2;
  ssl_ciphers ALL:!ADH:!EXPORT56:RC4+RSA:+HIGH:+MEDIUM:+LOW:+SSLv2:+EXP;

  location /wss
  {
    proxy_pass http://127.0.0.1:8282;
    proxy_http_version 1.1;
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection "Upgrade";
    proxy_set_header X-Real-IP $remote_addr;
  }

  # location / {} 站点的其它配置...
}

测试

// 证书是会检查域名的，请使用域名连接

ws = new WebSocket("wss://域名/wss");

ws.onopen = function() {
    alert("连接成功");
    ws.send('tom');
    alert("给服务端发送一个字符串：tom");
};
ws.onmessage = function(e) {
    alert("收到服务端的消息：" + e.data);
};

---

另外为了方便测试，大家也可以使用在线测试工具，如 websocket在线测试